home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / sfdays.zip / SFDAYS.DOC < prev    next >
Text File  |  1993-01-01  |  8KB  |  184 lines
  1.                                   SFDAYS
  2.                                Version 1.0
  3.                     Copyright (C) by Mike Woltz, 1993
  4.                           Buffalo Creek Software
  5.     
  6.  
  7.     INTRODUCTION
  8.     ------------
  9.  
  10.        SFDAYS is a SPITFIRE companion utility.  It is designed to be
  11.     used in conjunction with SPITFIRE's daily scheduled events to execute
  12.     a series of commands provided the day of the month entered as a command
  13.     line parameter is equal to the system's date.  SFDAYS is written by
  14.     in Turbo Assembler by Mike Woltz, author of SPITFIRE.
  15.  
  16.  
  17.     COMMAND LINE PARAMETERS
  18.     -----------------------
  19.     
  20.        Valid command line parameters may be any date or any number of
  21.     days of the month.  For example:
  22.  
  23.        SFDAYS 1
  24.        
  25.     would execute the commands in SF.BAT for the respective event on the
  26.     first day of each month.
  27.  
  28.    Similarly:
  29.  
  30.        SFDAYS 5 10 15 20 25 30
  31.     
  32.     would execute the commands in SF.BAT for the respective event on the 
  33.     5th, 10th, 15th, 20th, 25th and 30th day of the month.  
  34.    
  35.        The only limitation to the number of command line parameters that
  36.     can be used is DOS's restriction which limits the command line to 128
  37.     characters.
  38.     
  39.     
  40.     USAGE
  41.     -----
  42.  
  43.        Before attempting to use SFDAYS, you should be familiar with how
  44.     to set up a SPITFIRE scheduled event.  For additional information
  45.     on setting up a scheduled event in SPITFIRE please refer to the
  46.     SPITFIRE documentation section entitled: Events Menu Explanation.
  47.     
  48.        Begin by setting up an event for using SFDAYS by selecting
  49.     <E>...Enable An Event from SPITFIRE's Events Menu.  Once you have
  50.     done this, SPITFIRE will provide a series of prompts which allow you 
  51.     to enter the information needed by SPITFIRE to enable the event.  First 
  52.     you are asked to enter the time at which the event will occur.  Next, 
  53.     you are presented with the option of selecting what day the event will 
  54.     be activated.  It is important that 7 be selected for All.  Next, 
  55.     SPITFIRE will ask whether the event should be marked as completed.  The
  56.     final prompt determines whether the event is to be marked as an "on time"
  57.     event.
  58.     
  59.     ** NOTE **   The reason for selecting 7 for All should be obvious.  
  60.     If you were configuring SFDAYS for the 10th of the month and set it 
  61.     up as an event which is only run on Sunday, the 10th would have to
  62.     fall on Sunday or your commands in the batch file would not be executed.  
  63.     Therefore, to ensure your commands are executed the 10th of each month, 
  64.     regardless of the day of the week, All is selected when creating the 
  65.     event.
  66.  
  67.        Next, you will need to modify your SF.BAT.  A sample batch file,
  68.     SFDAYS.SAM may be used as a guide.
  69.     
  70.     
  71.     A SAMPLE CONFIGURATION OF SFDAYS
  72.     -------------------------------- 
  73.     
  74.        For the purpose of demonstrations, let's assume we wanted to set 
  75.     up Event_A to run Buffalo Creek Software's SFTOPTEN each night and
  76.     SFLOG on the 10th, 20th and 30th day of each month.  (SFTOPTEN creates 
  77.     a bulletin of the BBS's top ten callers.  SFLOG creates a bulletin of 
  78.     system activity and is then used to initiate a new log file.)  
  79.     
  80.        Using the process described above, Enable Event A so that it will
  81.     run at 00:01 (1 minute after midnight) each night (7 for All).
  82.    
  83.        Next, using your favorite text editor (one which saves in ASCII
  84.     format) locate the following in your SF.BAT:
  85.     
  86.     :EVENT_A
  87.       REM Place Event Commands Here
  88.       GOTO LOOP
  89.     
  90.     The commands for executing SFDAYS as a nightly event should be placed
  91.     between :EVENT_A and the GOTO LOOP statements as follows:
  92.  
  93.     :EVENT_A    
  94.       SFDAYS 10 20 30
  95.       IF ERRORLEVEL 1 GOTO NOT_A_DAY
  96.       GOTO A_DAY
  97.     :A_DAY
  98.       CD\SF\WORK
  99.       SFLOG /BULLET1
  100.       COPY BULLET1.* \SF\DISPLAY
  101.       DEL BULLET1.*
  102.       GOTO NOT_A_DAY
  103.     :NOT_A_DAY
  104.       CD\SF\WORK
  105.       SFTOPTEN C:\SF\DISPLAY\BULLET4
  106.       CD\SF
  107.       GOTO LOOP
  108.     :EVENT_B
  109.       REM Place Event Commands Here
  110.       GOTO LOOP
  111.      . . . etc.
  112.      
  113.     (** NOTE **   If SFDAYS.COM is not in your path, you should either 
  114.     precede it with the drive letter and directory name or change to the 
  115.     drive and directory where it resides prior to executing the command.
  116.     Also, any reference to directories using the SPITFIRE utilities SFLOG
  117.     and SFTOPTEN should be replaced to correspond to the drives and
  118.     directories suitable for your system structure.)
  119.     
  120.        Using the above example, when Event_A is activated, SFDAYS will
  121.     check to see if the system date is equal to 10, 20 or 30.  If the
  122.     system date does not match any of these, an ERRORLEVEL of 1 is returned
  123.     and the batch file continues to execute the commands within NOT_A_DAY.
  124.     (In other words, if the system date does not match 10, 20 or 30 the
  125.     batch file will proceed by changing to the \SF\WORK directory, executing
  126.     the SFTOPTEN utility and then changing back to the SF directory before 
  127.     returning to SPITFIRE.)
  128.    
  129.        If ERRORLEVEL 0 is returned when SFDAYS is executed (the system date
  130.     is equal to the 10th, 20th or 30th) the batch file will continue to
  131.     process the commands within A_DAY.  (In other words, it will change to
  132.     the \SF\WORK directory, execute SFLOG, copy the created bulletin files
  133.     to \SF\DISPLAY, erase the bulletin files in the current directory, and
  134.     then continue on to process the commands within NOT_A_DAY.  Refer above
  135.     for the processing associated with NOT_A_DAY.)
  136.     
  137.     
  138.     GENERAL INFORMATION
  139.     -------------------
  140.     
  141.        Once you understand the concept of SFDAYS, its potential is virtually
  142.     unlimited.  Any number of programs can be set up as scheduled events with
  143.     SFDAYS to handle these tasks at regular intervals according to the day of
  144.     the month.
  145.       
  146.  
  147.     DISTRIBUTION
  148.     ------------
  149.  
  150.        The following files are included in the distribution package:
  151.        
  152.     SFDAYS.COM     Executable program file
  153.     SFDAYS.SAM     Sample batch file illustrating usage of SFDAYS.COM
  154.     SFDAYS.DOC     Documenation for SFDAYS.COM
  155.  
  156.  
  157.        SFDAYS is distributed under the shareware concept.  You are free to 
  158.     distribute the SFDAYS program as long as it remains unmodified and no fee
  159.     is charged.  If you continue to use this program after an adequate 
  160.     evaluation period a registration fee is required.  To register SFDAYS, 
  161.     send $1.00 to the following address:
  162.     
  163.                       Buffalo Creek  Software
  164.                       Attn: Mike Woltz
  165.                       913 - 39th Street
  166.                       West Des Moines, Iowa  50265
  167.  
  168.  
  169.     DISCLAIMER
  170.     ----------
  171.         
  172.        Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  173.     responsible for any damage incurred while operating SFDAYS.  All 
  174.     responsibility lies with the user of the software.
  175.  
  176.        The documentation for SFDAYS is contributed by Jacque Shipley and 
  177.     The Mother Board BBS.  The shareware version of SPITFIRE and other 
  178.     SPITFIRE utilities are available for download from:
  179.  
  180.          Buffalo Creek's BBS              The Mother Board BBS
  181.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  182.            (515) 225-8496                    (515) 986-3464
  183.     38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  184.